ListTemplates
Description
call the ListTemplates interface to query the template list.
Request Method
POST
Request Path
/apsara/route/ROS/ListTemplates
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
Tag.N.Key | BODY | string | No | TestKey | the tag key of the template. The value range of n is 1~20. If this value is specified, an empty string is not allowed. supports up to 128 characters, cannot start with aliyun and acs:, and cannot contain http:// or https://. |
PageSize | BODY | long | No | 1 | the number of rows per page set during paging query. Value range: 1~50. default value: 10. |
PageNumber | BODY | long | No | 10 | page number of the template list. starting value: 1. default value: 1. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
Tag.N.Value | BODY | string | No | TestValue | the tag value of the template. The value range of n is 1~20. If this value is specified, it can be an empty string. supports up to 128 characters, cannot start with aliyun and acs:, and cannot contain http:// or https://. |
TemplateName | BODY | string | No | MyTemplate | template name. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_). |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
TotalCount | integer | 3 | total number of templates. |
Description | string | test-description | template description. |
RequestId | string | C3A8413B-1F16-4DED-AC3E-61A00718DE8A | request ID. |
PageSize | integer | 10 | the number of rows per page set during paging query. |
PageNumber | integer | 1 | page number of the template list. starting value: 1. |
CreateTime | string | 2019-10-15T08:17:14.000000 | creation time. |
UpdateTime | string | 2019-10-15T08:17:14.000000 | update time. |
Templates | array of template | No sample value for this parameter. | template list. |
TemplateName | string | test-list-templates | template name. |
TemplateId | string | 4d4f5aa2-3260-4e47-863b-763fbb12**** | template ID. |
Example
Successful Response example
{
"TotalCount":"3",
"Description":"test-description",
"RequestId":"C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
"PageSize":"10",
"PageNumber":"1",
"CreateTime":"2019-10-15T08:17:14.000000",
"UpdateTime":"2019-10-15T08:17:14.000000",
"Templates":"",
"TemplateName":"test-list-templates",
"TemplateId":"4d4f5aa2-3260-4e47-863b-763fbb12****"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}